<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>RankingController (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="RankingController (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RankingController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/ranking/api/RankingEvent.html" title="interface in org.gephi.ranking.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/RankingController.html" target="_top">Frames</a></li>
<li><a href="RankingController.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.ranking.api</div>
<h2 title="Interface RankingController" class="title">Interface RankingController</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">RankingController</span></pre>
<div class="block">Controller that maintains the ranking models, one per workspace.
 <p>
 This controller is a service and can therefore be found in Lookup:
 <pre>RankingController rc = Lookup.getDefault().lookup(RankingController.class);</pre>
 <p>
 Use <code>transform()</code> to apply transformers on ranking's elements. Transform
 is a one shot action. For continuous transformation, start an auto transformer
 using <code>startAutoTransform()</code>.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api"><code>RankingModel</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api">RankingModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#getModel()">getModel</a></strong>()</code>
<div class="block">Returns the ranking model of the current workspace.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api">RankingModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#getModel(org.gephi.project.api.Workspace)">getModel</a></strong>(<a href="../../../../org/gephi/project/api/Workspace.html" title="interface in org.gephi.project.api">Workspace</a>&nbsp;workspace)</code>
<div class="block">Returns the ranking model of <code>workspace</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#setInterpolator(org.gephi.ranking.api.Interpolator)">setInterpolator</a></strong>(<a href="../../../../org/gephi/ranking/api/Interpolator.html" title="class in org.gephi.ranking.api">Interpolator</a>&nbsp;interpolator)</code>
<div class="block">Sets the interpolator to be used when transforming values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#setUseLocalScale(boolean)">setUseLocalScale</a></strong>(boolean&nbsp;useLocalScale)</code>
<div class="block">Sets whether rankings use a local or a global scale.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#startAutoTransform(org.gephi.ranking.api.Ranking, org.gephi.ranking.api.Transformer)">startAutoTransform</a></strong>(<a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>&nbsp;ranking,
                  <a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</code>
<div class="block">Starts an auto transformation using <code>ranking</code> and 
 <code>transformer</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#stopAutoTransform(org.gephi.ranking.api.Transformer)">stopAutoTransform</a></strong>(<a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</code>
<div class="block">Stops the auto transformation of <code>transfromer</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/ranking/api/RankingController.html#transform(org.gephi.ranking.api.Ranking, org.gephi.ranking.api.Transformer)">transform</a></strong>(<a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>&nbsp;ranking,
         <a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</code>
<div class="block">Apply the transformation of <code>transformer</code> on <code>ranking</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getModel()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModel</h4>
<pre><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api">RankingModel</a>&nbsp;getModel()</pre>
<div class="block">Returns the ranking model of the current workspace.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the ranking model of the current workspace</dd></dl>
</li>
</ul>
<a name="getModel(org.gephi.project.api.Workspace)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModel</h4>
<pre><a href="../../../../org/gephi/ranking/api/RankingModel.html" title="interface in org.gephi.ranking.api">RankingModel</a>&nbsp;getModel(<a href="../../../../org/gephi/project/api/Workspace.html" title="interface in org.gephi.project.api">Workspace</a>&nbsp;workspace)</pre>
<div class="block">Returns the ranking model of <code>workspace</code>. If it doesn't exists,
 it creates one and put it in the workspace.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>workspace</code> - the workspace containing the model</dd>
<dt><span class="strong">Returns:</span></dt><dd>the ranking model of this workspace</dd></dl>
</li>
</ul>
<a name="setInterpolator(org.gephi.ranking.api.Interpolator)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInterpolator</h4>
<pre>void&nbsp;setInterpolator(<a href="../../../../org/gephi/ranking/api/Interpolator.html" title="class in org.gephi.ranking.api">Interpolator</a>&nbsp;interpolator)</pre>
<div class="block">Sets the interpolator to be used when transforming values. This is set to the
 current model only. If the model is changed (i.e. switch workspace), call 
 this again.
 <p>
 Default interpolator implementations can be found in the <a href="../../../../org/gephi/ranking/api/Interpolator.html" title="class in org.gephi.ranking.api"><code>Interpolator</code></a>
 class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interpolator</code> - the interpolator to use for transformation.</dd></dl>
</li>
</ul>
<a name="setUseLocalScale(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUseLocalScale</h4>
<pre>void&nbsp;setUseLocalScale(boolean&nbsp;useLocalScale)</pre>
<div class="block">Sets whether rankings use a local or a global scale. When calculating the
 minimum and maximum value (i.e. the scale) rankings can use the complete graph
 or only the currently visible graph. When using the visible graph it is called
 the <b>local</b> scale.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>useLocalScale</code> - <code>true</code> for local, <code>false</code> for global</dd></dl>
</li>
</ul>
<a name="transform(org.gephi.ranking.api.Ranking, org.gephi.ranking.api.Transformer)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transform</h4>
<pre>void&nbsp;transform(<a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>&nbsp;ranking,
             <a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</pre>
<div class="block">Apply the transformation of <code>transformer</code> on <code>ranking</code>.
 The transformer will modify element's color or size according to the values
 returned by the ranking. Before passing values to the transformer, they may
 be transformer by the current interpolator.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ranking</code> - the ranking to give to the transformer</dd><dd><code>transformer</code> - the transformer to apply on the ranking's elements</dd></dl>
</li>
</ul>
<a name="startAutoTransform(org.gephi.ranking.api.Ranking, org.gephi.ranking.api.Transformer)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startAutoTransform</h4>
<pre>void&nbsp;startAutoTransform(<a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api">Ranking</a>&nbsp;ranking,
                      <a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</pre>
<div class="block">Starts an auto transformation using <code>ranking</code> and 
 <code>transformer</code>. The transformation is continuously applied to
 the current graph. The operation is the same as <code>transform()</code>, 
 except it is applied in a loop until <code>stopAutoTransform()</code> is
 called.
 <p>
 Note that auto transformation work only in the current workspace and are
 paused when the workspace is not current.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ranking</code> - the ranking to give to the transformer</dd><dd><code>transformer</code> - the transformer to apply on the ranking's elements</dd></dl>
</li>
</ul>
<a name="stopAutoTransform(org.gephi.ranking.api.Transformer)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stopAutoTransform</h4>
<pre>void&nbsp;stopAutoTransform(<a href="../../../../org/gephi/ranking/api/Transformer.html" title="interface in org.gephi.ranking.api">Transformer</a>&nbsp;transformer)</pre>
<div class="block">Stops the auto transformation of <code>transfromer</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transformer</code> - the transformer to stop auto transformation</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RankingController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/ranking/api/Ranking.html" title="interface in org.gephi.ranking.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/ranking/api/RankingEvent.html" title="interface in org.gephi.ranking.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/ranking/api/RankingController.html" target="_top">Frames</a></li>
<li><a href="RankingController.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
